Commenting Intent

$npx mdskill add obra/clank/Commenting Intent

Clarify code intent by explaining decisions, not mechanics.

  • Prevents redundant comments that merely restate obvious code.
  • Targets complex algorithms and non-obvious design choices.
  • Identifies when magic numbers or unclear reasoning exist.
  • Guides future maintainers to understand project reasoning.

SKILL.md

.github/skills/Commenting IntentView on GitHub ↗

No skill content available yet.

More from obra/clank

SkillDescription
Creating SkillsTDD for process documentation - test with subagents before writing, iterate until bulletproof
Designing Before CodingDesign in pseudocode first, iterate approaches, then translate to code
Domain-Focused NamingName code by what it does in the domain, not how it's implemented or its history
Encapsulating ComplexityHide implementation details behind interfaces - work at domain level (what), not implementation level (how)
Exploring AlternativesTry 2-3 different approaches before implementing - don't settle for first design you think of
Installing Skills SystemFork, clone to ~/.clank, run installer, edit CLAUDE.md
Keeping Routines FocusedEach routine does one thing and does it well - extract when routines have multiple responsibilities
Localizing VariablesDeclare variables in smallest possible scope, initialize close to first use, minimize span and live time
Maintaining Consistent AbstractionsClass interfaces present one cohesive abstraction - don't mix domain logic with serialization, persistence, or unrelated concerns
Naming VariablesChoose names that fully and accurately describe what the variable represents